Upgrades
This upgrade guide provides a step by step process for performing an upgrade of an existing project to the latest version of Brightspot and covers a majority of scenarios or issues that may occur during an upgrade.
If you believe anything is missing from the documentation, please reach out to your Brightspot representative to ensure that we can continue to keep this up to date and accurate.
Clean diffs
Brightspot recommends unnecessary file changes which result in noisy diffs. Brightspot also recommends disabling auto-formatting on your IDE/editor to ensure that no unintended formatting changes occur.
By ensuring that the diff is clean (i.e. no extra formatting changes), you can promote thorough reviews of the upgrade code by the reviewer, as well as avoid unexpected merge conflicts with the rest of your engineering team.
Flag/file any unexpected issues
If anything occurs during an upgrade that is unexpected, or if something is unclear based on the documentation, make sure to flag it to a Brightspot representative. This will ensure that everything is being done correctly, and any gaps in documentation are handled.
Keep commits small and succinct
Ensure that commits are small and specific to the task at hand. This can help reviews, but can also ensure that reverting changes is easier to execute (for example, if a lot of auto-formatting happened, Brightspot would want to ensure that can be easily undone).
Clean operation if active development
If there is active development on the project that you are upgrading, discuss a plan with the project team before you begin to help avoid merge conflicts.